\nEvent service\n
", "extensionPoints": [ { "@type": "NXExtensionPoint", "componentId": "org.nuxeo.ecm.core.event.EventServiceComponent", "descriptors": [ "org.nuxeo.ecm.core.event.impl.EventListenerDescriptor" ], "documentation": "\n Extension point defining event listeners.\n\n An event listener describes some Java code that can be executed\n synchronously or asynchronously when an event is fired by Nuxeo code.\n\n Example listener:\n\n \n documentCreated \n documentModified \n \n\n\n\n The events listed are those for which the listener will be called.\n If there are none, the listener is called for all events, but this is strongly\n discouraged for performance reasons.\n\n Listeners belong to one of three categories:\n\n If postCommit=false then the listener is purely synchronous\n (also called \"inline\") and executed in the same thread and transaction\n as the code firing the event, as a regular method call.\n The class must implement org.nuxeo.ecm.core.event.EventListener,\n which receives events one at a time.\n\n If postCommit=true and async=true then the listener is purely\n asynchronous and executed at an arbitrary later point in time\n (but after the original transaction is committed), in its own thread and transaction.\n It may be retried if a ConcurrentUpdateException is detected.\n The listener is executed asynchronously by the WorkManager via a Work instance\n whose category (which determines the Work queue used) is the listener's name.\n The class must implement org.nuxeo.ecm.core.event.PostCommitEventListener,\n which receives a bundle of all the events raised by the original transaction.\n\n If postCommit=true and async=false then the listener is executed synchronously\n immediately after the original transaction is committed, but in a separate transaction.\n It is not executed if the original transaction does a rollback.\n All listeners in this category are executed one after the other (in priority order),\n and only after they are all done does the main thread continue execution.\n (However if one of the listeners takes too long it is left to run purely asynchronously\n and the other listeners in this category are processed.)\n The class must implement org.nuxeo.ecm.core.event.PostCommitEventListener,\n which receives a bundle of all the events raised by the original transaction.\n\n The priority gives a global ordering of all the listeners\n in the same category executed for a given event.\n The default is 0.\n\n The retryCount specifies how many times a purely asynchronous listener\n may retry execution if it resulted in a ConcurrentUpdateException.\n The default is 1.\n \n",
"documentationHtml": "\nExtension point defining event listeners.\n
\nAn event listener describes some Java code that can be executed\nsynchronously or asynchronously when an event is fired by Nuxeo code.\n
\nExample listener:\n
<listener async="false"\n class="org.nuxeo.ecm.platform.dublincore.listener.DublinCoreListener"\n enabled="true" name="mylistener" postCommit="false"\n priority="50" retryCount="1">\n <event>documentCreated</event>\n <event>documentModified</event>\n </listener>\n\nThe events listed are those for which the listener will be called.\nIf there are none, the listener is called for all events, but this is strongly\ndiscouraged for performance reasons.\n
\nListeners belong to one of three categories:\n
\nIf postCommit=false then the listener is purely synchronous\n(also called "inline") and executed in the same thread and transaction\nas the code firing the event, as a regular method call.\nThe class must implement org.nuxeo.ecm.core.event.EventListener,\nwhich receives events one at a time.\n
\nIf postCommit=true and async=true then the listener is purely\nasynchronous and executed at an arbitrary later point in time\n(but after the original transaction is committed), in its own thread and transaction.\nIt may be retried if a ConcurrentUpdateException is detected.\nThe listener is executed asynchronously by the WorkManager via a Work instance\nwhose category (which determines the Work queue used) is the listener's name.\nThe class must implement org.nuxeo.ecm.core.event.PostCommitEventListener,\nwhich receives a bundle of all the events raised by the original transaction.\n
\nIf postCommit=true and async=false then the listener is executed synchronously\nimmediately after the original transaction is committed, but in a separate transaction.\nIt is not executed if the original transaction does a rollback.\nAll listeners in this category are executed one after the other (in priority order),\nand only after they are all done does the main thread continue execution.\n(However if one of the listeners takes too long it is left to run purely asynchronously\nand the other listeners in this category are processed.)\nThe class must implement org.nuxeo.ecm.core.event.PostCommitEventListener,\nwhich receives a bundle of all the events raised by the original transaction.\n
\nThe priority gives a global ordering of all the listeners\nin the same category executed for a given event.\nThe default is 0.\n
\nThe retryCount specifies how many times a purely asynchronous listener\nmay retry execution if it resulted in a ConcurrentUpdateException.\nThe default is 1.\n
", "hierarchyPath": "/grp:org.nuxeo.ecm.core/org.nuxeo.ecm.core.event/org.nuxeo.ecm.core.event.EventServiceComponent/ExtensionPoints/org.nuxeo.ecm.core.event.EventServiceComponent--listener", "id": "org.nuxeo.ecm.core.event.EventServiceComponent--listener", "label": "listener (org.nuxeo.ecm.core.event.EventServiceComponent)", "name": "listener", "version": "2021.62.7" }, { "@type": "NXExtensionPoint", "componentId": "org.nuxeo.ecm.core.event.EventServiceComponent", "descriptors": [ "org.nuxeo.ecm.core.event.pipe.EventPipeDescriptor" ], "documentation": "\n Extension point to contribute event pipe.\n\n An event pipe is a where Nuxeo events will be sent for asynchronous processing.\n\n Example pipe definition:\n\n \n \n bar \n \n \n\n",
"documentationHtml": "\nExtension point to contribute event pipe.\n
\nAn event pipe is a where Nuxeo events will be sent for asynchronous processing.\n
\nExample pipe definition:\n
<eventPipe class="org.nuxeo.ecm.core.event.pipe.DummyPipe"\n name="dummyPipe1" priority="0">\n <parameters>\n <parameter name="foo">bar</parameter>\n </parameters>\n </eventPipe>\n\n \n \n bar \n \n \n \n",
"documentationHtml": "\nExtension point to define the dispatcher used to dispatch event between pipes.\n
\nExample dispatcher definition:\n
<eventDispatcher\n class="org.nuxeo.ecm.core.event.pipe.dispatch.SimpleEventBundlePipeDispatcher" name="dispatcher">\n <parameters>\n <parameter name="foo">bar</parameter>\n </parameters>\n </eventDispatcher>\n\nExtension point to define Stream Domain Event Producers.\n
", "hierarchyPath": "/grp:org.nuxeo.ecm.core/org.nuxeo.ecm.core.event/org.nuxeo.ecm.core.event.EventServiceComponent/ExtensionPoints/org.nuxeo.ecm.core.event.EventServiceComponent--domainEventProducer", "id": "org.nuxeo.ecm.core.event.EventServiceComponent--domainEventProducer", "label": "domainEventProducer (org.nuxeo.ecm.core.event.EventServiceComponent)", "name": "domainEventProducer", "version": "2021.62.7" } ], "extensions": [ { "@type": "NXContribution", "documentationHtml": "", "extensionPoint": "org.nuxeo.ecm.core.event.EventServiceComponent--listener", "hierarchyPath": "/grp:org.nuxeo.ecm.core/org.nuxeo.ecm.core.event/org.nuxeo.ecm.core.event.EventServiceComponent/Contributions/org.nuxeo.ecm.core.event.EventServiceComponent--listener", "id": "org.nuxeo.ecm.core.event.EventServiceComponent--listener", "registrationOrder": 0, "targetComponentName": { "rawName": "service:org.nuxeo.ecm.core.event.EventServiceComponent", "name": "org.nuxeo.ecm.core.event.EventServiceComponent", "type": "service" }, "version": "2021.62.7", "xml": "\n \n documentCreated \n documentModified \n \n \n\n The events listed are those for which the listener will be called.\n If there are none, the listener is called for all events, but this is strongly\n discouraged for performance reasons.\n\n Listeners belong to one of three categories:\n\n If postCommit=false then the listener is purely synchronous\n (also called \"inline\") and executed in the same thread and transaction\n as the code firing the event, as a regular method call.\n The class must implement org.nuxeo.ecm.core.event.EventListener,\n which receives events one at a time.\n\n If postCommit=true and async=true then the listener is purely\n asynchronous and executed at an arbitrary later point in time\n (but after the original transaction is committed), in its own thread and transaction.\n It may be retried if a ConcurrentUpdateException is detected.\n The listener is executed asynchronously by the WorkManager via a Work instance\n whose category (which determines the Work queue used) is the listener's name.\n The class must implement org.nuxeo.ecm.core.event.PostCommitEventListener,\n which receives a bundle of all the events raised by the original transaction.\n\n If postCommit=true and async=false then the listener is executed synchronously\n immediately after the original transaction is committed, but in a separate transaction.\n It is not executed if the original transaction does a rollback.\n All listeners in this category are executed one after the other (in priority order),\n and only after they are all done does the main thread continue execution.\n (However if one of the listeners takes too long it is left to run purely asynchronously\n and the other listeners in this category are processed.)\n The class must implement org.nuxeo.ecm.core.event.PostCommitEventListener,\n which receives a bundle of all the events raised by the original transaction.\n\n The priority gives a global ordering of all the listeners\n in the same category executed for a given event.\n The default is 0.\n\n The retryCount specifies how many times a purely asynchronous listener\n may retry execution if it resulted in a ConcurrentUpdateException.\n The default is 1.\n \n \n\t \n\t bar \n\t \n\t \n \n \n \n \n bar \n \n \n \n \nThe WorkManager executes Work instances asynchronously.\n
", "extensionPoints": [ { "@type": "NXExtensionPoint", "componentId": "org.nuxeo.ecm.core.work.service", "descriptors": [ "org.nuxeo.ecm.core.work.api.WorkQueueDescriptor" ], "documentation": "\n Defines the characteristics of work queues:\n\n \n My Queue \n 4 \n 100 \n 300 \n somecategory1 \n somecategory2 \n \n\n\n - id is the queue id.\n\n - name is the human-readable name.\n\n - maxThreads maximum number of worker threads (default 4).\n\n - capacity when specified make the queue bounded, the scheduling of\n new work is blocking when the queue is full (default unlimited).\n\n - clearCompletedAfterSeconds (default 3600) is the delay after which completed work\n may be automatically cleared from its queue. 0 means never.\n\n - category is a list of Work categories that this queue will receive.\n For event listeners work, the category is the listener name (or its simple class name).\n \n",
"documentationHtml": "\nDefines the characteristics of work queues:\n
<queue id="myqueue">\n <name>My Queue</name>\n <maxThreads>4</maxThreads>\n <capacity>100</capacity>\n <clearCompletedAfterSeconds>300</clearCompletedAfterSeconds>\n <category>somecategory1</category>\n <category>somecategory2</category>\n </queue>\n\n- id is the queue id.\n
\n- name is the human-readable name.\n
\n- maxThreads maximum number of worker threads (default 4).\n
\n- capacity when specified make the queue bounded, the scheduling of\nnew work is blocking when the queue is full (default unlimited).\n
\n- clearCompletedAfterSeconds (default 3600) is the delay after which completed work\nmay be automatically cleared from its queue. 0 means never.\n
\n- category is a list of Work categories that this queue will receive.\nFor event listeners work, the category is the listener name (or its simple class name).\n
", "hierarchyPath": "/grp:org.nuxeo.ecm.core/org.nuxeo.ecm.core.event/org.nuxeo.ecm.core.work.service/ExtensionPoints/org.nuxeo.ecm.core.work.service--queues", "id": "org.nuxeo.ecm.core.work.service--queues", "label": "queues (org.nuxeo.ecm.core.work.service)", "name": "queues", "version": "2021.62.7" }, { "@type": "NXExtensionPoint", "componentId": "org.nuxeo.ecm.core.work.service", "descriptors": [ "org.nuxeo.ecm.core.work.api.WorkQueuingDescriptor" ], "documentation": "\n Defines the implementation of the queuing mechanism:\n\n \n \n\n The class must be a subclass of org.nuxeo.ecm.core.work.WorkQueuing.\n \n",
"documentationHtml": "\nDefines the implementation of the queuing mechanism:\n
<queuing class="org.nuxeo.ecm.core.redis.contribs.RedisWorkQueuing"/>\n\nThe class must be a subclass of org.nuxeo.ecm.core.work.WorkQueuing.\n
", "hierarchyPath": "/grp:org.nuxeo.ecm.core/org.nuxeo.ecm.core.event/org.nuxeo.ecm.core.work.service/ExtensionPoints/org.nuxeo.ecm.core.work.service--implementation", "id": "org.nuxeo.ecm.core.work.service--implementation", "label": "implementation (org.nuxeo.ecm.core.work.service)", "name": "implementation", "version": "2021.62.7" } ], "extensions": [], "hierarchyPath": "/grp:org.nuxeo.ecm.core/org.nuxeo.ecm.core.event/org.nuxeo.ecm.core.work.service", "name": "org.nuxeo.ecm.core.work.service", "requirements": [], "resolutionOrder": 145, "services": [ { "@type": "NXService", "componentId": "org.nuxeo.ecm.core.work.service", "hierarchyPath": "/grp:org.nuxeo.ecm.core/org.nuxeo.ecm.core.event/org.nuxeo.ecm.core.work.service/Services/org.nuxeo.ecm.core.work.api.WorkManager", "id": "org.nuxeo.ecm.core.work.api.WorkManager", "overriden": false, "version": "2021.62.7" } ], "startOrder": 10, "version": "2021.62.7", "xmlFileContent": "\n\n \n My Queue \n 4 \n 100 \n 300 \n somecategory1 \n somecategory2 \n \n \n - id is the queue id.\n\n - name is the human-readable name.\n\n - maxThreads maximum number of worker threads (default 4).\n\n - capacity when specified make the queue bounded, the scheduling of\n new work is blocking when the queue is full (default unlimited).\n\n - clearCompletedAfterSeconds (default 3600) is the delay after which completed work\n may be automatically cleared from its queue. 0 means never.\n\n - category is a list of Work categories that this queue will receive.\n For event listeners work, the category is the listener name (or its simple class name).\n \n \n \n The class must be a subclass of org.nuxeo.ecm.core.work.WorkQueuing.\n \nThe default queue configuration for the work manager,\nthe scheduled job to cleanup the completed work instances,\nand the related listener.\n
", "extensionPoints": [], "extensions": [ { "@type": "NXContribution", "documentationHtml": "", "extensionPoint": "org.nuxeo.ecm.core.work.service--implementation", "hierarchyPath": "/grp:org.nuxeo.ecm.core/org.nuxeo.ecm.core.event/org.nuxeo.ecm.core.work.config/Contributions/org.nuxeo.ecm.core.work.config--implementation", "id": "org.nuxeo.ecm.core.work.config--implementation", "registrationOrder": 0, "targetComponentName": { "rawName": "service:org.nuxeo.ecm.core.work.service", "name": "org.nuxeo.ecm.core.work.service", "type": "service" }, "version": "2021.62.7", "xml": "\nCore scheduler registry service.\n
", "extensionPoints": [ { "@type": "NXExtensionPoint", "aliases": [ "org.nuxeo.ecm.platform.scheduler.core.service.SchedulerRegistryService--schedule" ], "componentId": "org.nuxeo.ecm.core.scheduler.SchedulerService", "descriptors": [ "org.nuxeo.ecm.core.scheduler.ScheduleImpl" ], "documentation": "\n Extension allowing the registration of schedules.\n This is similar to a cron job sending events. Note that\n contrary to UNIX cron there is an additional \"seconds\" field\n in the cron expression.\n \n\n A scheduler definition contains information about what event is sent,\n when, and under what identity.\n \n\n For instance :\n\n \n Administrator \n myEvent \n default \n \n 0 0 3 1 * ? \n UTC \n \n\n\n jobFactoryClass is optional and defaults to org.nuxeo.ecm.core.scheduler.DefaultEventJobFactory.\n timezone is optional and defaults to system default.\n\n @see org.quartz.CronTrigger\n @see org.nuxeo.ecm.core.scheduler.EventJobFactory\n @see http://www.quartz-scheduler.org/docs/api/1.8.1/org/quartz/CronExpression.html\n @see http://www.quartz-scheduler.org/docs/tutorials/crontrigger.html\n \n",
"documentationHtml": "\nExtension allowing the registration of schedules.\nThis is similar to a cron job sending events. Note that\ncontrary to UNIX cron there is an additional "seconds" field\nin the cron expression.\n
\nA scheduler definition contains information about what event is sent,\nwhen, and under what identity.\n
\nFor instance :\n
<schedule id="mySchedule" jobFactoryClass="org.nuxeo.ecm.core.scheduler.DefaultEventJobFactory">\n <username>Administrator</username>\n <event>myEvent</event>\n <eventCategory>default</eventCategory>\n <!-- Every first of the month at 3am -->\n <cronExpression>0 0 3 1 * ?</cronExpression>\n <timezone>UTC</timezone>\n </schedule>\n\njobFactoryClass is optional and defaults to org.nuxeo.ecm.core.scheduler.DefaultEventJobFactory.\ntimezone is optional and defaults to system default.\n
\n@see org.quartz.CronTrigger\n@see org.nuxeo.ecm.core.scheduler.EventJobFactory\n@see http://www.quartz-scheduler.org/docs/api/1.8.1/org/quartz/CronExpression.html\n@see http://www.quartz-scheduler.org/docs/tutorials/crontrigger.html\n
", "hierarchyPath": "/grp:org.nuxeo.ecm.core/org.nuxeo.ecm.core.event/org.nuxeo.ecm.core.scheduler.SchedulerService/ExtensionPoints/org.nuxeo.ecm.core.scheduler.SchedulerService--schedule", "id": "org.nuxeo.ecm.core.scheduler.SchedulerService--schedule", "label": "schedule (org.nuxeo.ecm.core.scheduler.SchedulerService)", "name": "schedule", "version": "2021.62.7" } ], "extensions": [ { "@type": "NXContribution", "documentation": "\n Delay Quartz scheduler start to avoid unique key constraint violation with qrtz_LOCKS table\n \n\n Default behavior is to delay for 5 seconds.\n\n @since 2021.19\n \n", "documentationHtml": "\nDelay Quartz scheduler start to avoid unique key constraint violation with qrtz_LOCKS table\n
\nDefault behavior is to delay for 5 seconds.\n
\n@since 2021.19\n
", "extensionPoint": "org.nuxeo.runtime.ConfigurationService--configuration", "hierarchyPath": "/grp:org.nuxeo.ecm.core/org.nuxeo.ecm.core.event/org.nuxeo.ecm.core.scheduler.SchedulerService/Contributions/org.nuxeo.ecm.core.scheduler.SchedulerService--configuration", "id": "org.nuxeo.ecm.core.scheduler.SchedulerService--configuration", "registrationOrder": 63, "targetComponentName": { "rawName": "service:org.nuxeo.runtime.ConfigurationService", "name": "org.nuxeo.runtime.ConfigurationService", "type": "service" }, "version": "2021.62.7", "xml": "\n \n Administrator \n myEvent \n default \n \n 0 0 3 1 * ? \n UTC \n \n \n jobFactoryClass is optional and defaults to org.nuxeo.ecm.core.scheduler.DefaultEventJobFactory.\n timezone is optional and defaults to system default.\n\n @see org.quartz.CronTrigger\n @see org.nuxeo.ecm.core.scheduler.EventJobFactory\n @see http://www.quartz-scheduler.org/docs/api/1.8.1/org/quartz/CronExpression.html\n @see http://www.quartz-scheduler.org/docs/tutorials/crontrigger.html\n